Skip to main content
PATCH
Update a native format's name or status.

Authorizations

Authorization
string
header
required

Bearer authentication. Pass the access token in the Authorization: Bearer <token> header.

Path Parameters

fid
string<uuid>
required

Body

application/json
description
string | null
name
string | null
Minimum string length: 1
status
enum<string> | null
Available options:
active,
inactive

Response

Successful Response

created_at
string<date-time>
required
id
string<uuid>
required

Unique identifier (UUID v7).

name
string
required

Human-readable name of the format.

owner_id
string<uuid>
required

ID of the operator who owns this format.

updated_at
string<date-time>
required
description
string | null

Optional description of the format.

format_type
enum<string>
default:user_defined

Whether this format is system-defined or user-defined.

Available options:
system_defined,
user_defined
no
integer | null
status
enum<string>
default:inactive

Operational status of the format.

Available options:
active,
inactive